/* if_ppp.h - Point-to-Point Protocol (PPP) Asynchronous driver header */

/* Copyright 1995 Wind River Systems, Inc. */

/*
 * Copyright (c) 1989 Carnegie Mellon University.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms are permitted
 * provided that the above copyright notice and this paragraph are
 * duplicated in all such forms and that any documentation,
 * advertising materials, and other materials related to such
 * distribution and use acknowledge that the software was developed
 * by Carnegie Mellon University.  The name of the
 * University may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

/*
modification history
--------------------
01b,09mar95,dzb  ppp_softc: added sc_iprcvd/sc_ipsent and removed bpf.
01a,16jan95,dab  VxWorks port - first WRS version.
           +dzb  WRS-ize.  moved in global prototypes from if_ppp.c.
*/

#ifndef	__INCif_ppph
#define	__INCif_ppph

#ifdef  __cplusplus
extern "C" {
#endif

/* includes */

#include "private/semLibP.h"
#include "rngLib.h"
#include "netinet/sl_compress.h"

/*
 * Standard PPP header.
 */
struct ppp_header {
	u_char	ph_address;	/* Address Field */
	u_char	ph_control;	/* Control Field */
	u_short	ph_protocol;	/* Protocol Field */
};

#define PPP_HDRLEN  	4	/* sizeof(struct ppp_header) must be 4 */
#define PPP_FCSLEN	2	/* octets for FCS */

#define PPP_ALLSTATIONS 0xff    /* All-Stations broadcast address */
#define PPP_UI          0x03    /* Unnumbered Information */
#define PPP_FLAG        0x7e    /* Flag Sequence */
#define PPP_ESCAPE      0x7d    /* Asynchronous Control Escape */
#define PPP_TRANS       0x20    /* Asynchronous transparency modifier */

/*
 * Protocol field values.
 */
#define PPP_IP          0x21    /* Internet Protocol */
#define PPP_XNS         0x25    /* Xerox NS */
#define PPP_VJC_COMP    0x2d    /* VJ compressed TCP */
#define PPP_VJC_UNCOMP  0x2f    /* VJ uncompressed TCP */
#define PPP_COMP        0xfd    /* compressed packet */
#define PPP_LCP         0xc021  /* Link Control Protocol */
#define PPP_CCP         0x80fd  /* Compression Control Protocol */

/*
 * Important FCS values.
 */
#define PPP_INITFCS     0xffff  /* Initial FCS value */
#define PPP_GOODFCS     0xf0b8  /* Good final FCS value */
#define PPP_FCS(fcs, c) (((fcs) >> 8) ^ fcstab[((fcs) ^ (c)) & 0xff])

/*
 * Packet sizes
 */
#define PPP_MTU         1500    /* Default MTU (size of Info field) */
#define PPP_MRU         1500    /* Default MRU (max receive unit) */
#define PPP_MAXMRU      65000   /* Largest MRU we allow */

/* Extended asyncmap - allows any character to be escaped. */
typedef u_long  ext_accm[8];

/*
 * Structure describing each ppp unit.
 */
struct ppp_softc {
	struct 	ifnet sc_if;	/* network-visible interface */
	u_int	sc_flags;	/* see below */
	void    *sc_devp;       /* pointer to device-dependent structure */
	int     (*sc_start)();  /* start routine */
	short   sc_mru;         /* max receive unit */
	int	sc_xfer;        /* used in xferring unit to another dev */
	struct  ifqueue sc_inq; /* TTY side input queue */
	struct  ifqueue sc_fastq; /* IP interactive output packet queue */
#ifdef  VJC
	struct  slcompress sc_comp; /* vjc control buffer */
#endif
	u_int   sc_bytessent;   /* count of octets sent */
	u_int   sc_bytesrcvd;   /* count of octets received */
	u_int	sc_ipsent;	/* count of ip packets sent */
	u_int	sc_iprcvd;	/* count of ip packets received */

        /* Device-dependent part for async lines. */
	ext_accm sc_asyncmap;   /* async control character map */
	u_long  sc_rasyncmap;   /* receive async control char map */
	struct  mbuf *sc_outm;  /* mbuf chain being output currently */
	struct  mbuf *sc_m;     /* pointer to input mbuf chain */
	struct  mbuf *sc_mc;    /* pointer to current input mbuf */
	char	*sc_mp;		/* pointer to next char in input mbuf */
	short	sc_ilen;	/* length of input-packet-so-far */
	u_short sc_fcs;         /* FCS so far (input) */
	u_short sc_outfcs;      /* FCS so far for output packet */
	u_char  sc_rawin[16];   /* chars as received */
	int     sc_rawin_count; /* # in sc_rawin */

	/* VxWorks-dependent part */
	int	sc_fd;		/* file descriptor */
	short	sc_qlen;	/* length of tty input queue */
	SEMAPHORE    sc_wrtsem;	/* write semaphore */
	int     sc_wrt_task_id;	/* write task ID */
	int 	pkt_len;	/* length of current packet */
	int     sc_tid;         /* tid of daemon task */
};

/* flags */
#define SC_COMP_PROT    0x00000001      /* protocol compression (output) */
#define SC_COMP_AC      0x00000002      /* header compression (output) */
#define SC_COMP_TCP     0x00000004      /* TCP (VJ) compression (output) */
#define SC_NO_TCP_CCID  0x00000008      /* disable VJ connection-id comp. */
#define SC_REJ_COMP_AC  0x00000010      /* reject adrs/ctrl comp. on input */
#define SC_REJ_COMP_TCP 0x00000020      /* reject TCP (VJ) comp. on input */
#define SC_ENABLE_IP    0x00000100      /* IP packets may be exchanged */
#define SC_DEBUG        0x00010000      /* enable debug messages */
#define SC_LOG_INPKT    0x00020000      /* log contents of good pkts recvd */
#define SC_LOG_OUTPKT   0x00040000      /* log contents of pkts sent */
#define SC_LOG_RAWIN    0x00080000      /* log all chars received */
#define SC_LOG_FLUSH    0x00100000      /* log all chars flushed */
#define SC_MASK         0x0fffffff      /* bits that user can change */

/* state bits */
#define SC_ESCAPED      0x80000000      /* saw a PPP_ESCAPE */
#define SC_FLUSH        0x40000000      /* flush input until next PPP_FLAG */
#define SC_DISCARD_PKT  0x20000000      /* Discard packet at interrupt level */
#define SC_RCV_B7_0     0x01000000      /* have rcvd char with bit 7 = 0 */
#define SC_RCV_B7_1     0x02000000      /* have rcvd char with bit 7 = 0 */
#define SC_RCV_EVNP     0x04000000      /* have rcvd char with even parity */
#define SC_RCV_ODDP     0x08000000      /* have rcvd char with odd parity */

/* this stuff doesn't belong here... */
#define	PPPIOCGSEM	_IOR('t', 92, int)	/* get ppp read semaphore */
#define	PPPIOCGFD	_IOR('t', 91, int)	/* get ppp underlying fd */
#define PPPIOCGFLAGS    _IOR('t', 90, int)      /* get configuration flags */
#define PPPIOCSFLAGS    _IOW('t', 89, int)      /* set configuration flags */
#define PPPIOCGASYNCMAP _IOR('t', 88, int)      /* get async map */
#define PPPIOCSASYNCMAP _IOW('t', 87, int)      /* set async map */
#define PPPIOCGUNIT     _IOR('t', 86, int)      /* get ppp unit number */
#define PPPIOCGRASYNCMAP _IOR('t', 85, int)     /* get receive async map */
#define PPPIOCSRASYNCMAP _IOW('t', 84, int)     /* set receive async map */
#define PPPIOCGMRU      _IOR('t', 83, int)      /* get max receive unit */
#define PPPIOCSMRU      _IOW('t', 82, int)      /* set max receive unit */
#define PPPIOCSMAXCID   _IOW('t', 81, int)      /* set VJ max slot ID */
#define PPPIOCGXASYNCMAP _IOR('t', 80, ext_accm) /* get extended ACCM */
#define PPPIOCSXASYNCMAP _IOW('t', 79, ext_accm) /* set extended ACCM */
#define PPPIOCXFERUNIT  _IO('t', 78)            /* transfer PPP unit */

#ifdef ultrix
#define ifr_mtu ifr_ifru.ifru_metric
#endif

/* old copies of PPP may have defined this */
#if !defined(ifr_mtu)
#define ifr_mtu	ifr_metric
#endif

/* function declarations */

extern int pppopen __ARGS((int, char *));
extern int pppclose __ARGS((int));
extern int pppread __ARGS((int , char *, int));
extern int pppwrite __ARGS((int , char *, int));
extern int ppptioctl __ARGS((int , int , caddr_t));
extern void ppp_wrt_task __ARGS((struct ppp_softc *));

#ifdef  __cplusplus
}
#endif

#endif	/* __INCif_ppph */
